/**
 * The MIT License (MIT)
 *
 * Igor Zinken 2024 - https://www.igorski.nl
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
import { EXECUTION_BUDGET } from "@/definitions/config";

let startTime = 0;

/**
 * Call before a series of heavy operations to set the start time
 */
export const prepare = (): void => {
    startTime = window.performance.now();
};

/**
 * Await this function in between heavy operations to determine
 * whether there is still time to continue or whether to wait
 * for a single RAF to unblock UI rendering.
 * 
 * If there is no time left, this will await the next animationFrame
 * before resolving, otherwise this return immediately without stalling execution.
 */
export const waitWhenBusy = async (): Promise<void> => {
    const now = window.performance.now();
    const elapsed = now - startTime;

    if ( elapsed > EXECUTION_BUDGET ) {
        return waitRaf();
    }
};

async function waitRaf(): Promise<void> {
    return new Promise( resolve => {
        window.requestAnimationFrame( time => {
            startTime = time;
            resolve();
        });
    });
}